org.eclipse.vtp.framework.spi
Interface IProcessDescriptor

All Known Implementing Classes:

Deployment

public interface IProcessDescriptor

A descriptor for process instances.

Author:

Lonnie Pryor

Method Summary

java.lang.String	getProcessID() Returns the ID of the process being described.
java.lang.Object	getProperty(java.lang.String propertyName) Returns the value of the property with the specified name or null if no such property exists.
java.lang.Object	getService(java.lang.String identifier) Returns the service selected for the specified identifier or null if no such service exists.
java.lang.String[]	getServiceIdentifiers() Returns the identifiers of all the externally-provided services.
boolean	isSeverityEnabled(int severity) Returns true if the specified report severity level is enabled.
java.lang.Class	loadClass(java.lang.String className) Loads a class visible to the process.
void	report(int severity, java.lang.String[] categories, java.lang.String message, java.util.Dictionary properties) Notifies this descriptor of a report made during the execution of the process.

Method Detail

getProcessID

java.lang.String getProcessID()

Returns the ID of the process being described.

Returns:

The ID of the process being described.

getServiceIdentifiers

java.lang.String[] getServiceIdentifiers()

Returns the identifiers of all the externally-provided services.

Returns:

The identifiers of all the externally-provided services.

getService

java.lang.Object getService(java.lang.String identifier)
                            throws java.lang.NullPointerException

Returns the service selected for the specified identifier or null if no such service exists.

Parameters:

identifier - The identifier of the service to return.

Returns:

The service selected for the specified identifier or null if no such service exists.

Throws:

java.lang.NullPointerException - If the supplied identifier is null.

getProperty

java.lang.Object getProperty(java.lang.String propertyName)
                             throws java.lang.NullPointerException

Returns the value of the property with the specified name or null if no such property exists.

Parameters:

propertyName - The name of the property to return.

Returns:

The value of the property with the specified name or null if no such property exists.

Throws:

java.lang.NullPointerException - If the specified property name is null.

loadClass

java.lang.Class loadClass(java.lang.String className)
                          throws java.lang.ClassNotFoundException,
                                 java.lang.NullPointerException

Loads a class visible to the process.

Parameters:

className - The name of the class to load.

Returns:

The requested class instance.

Throws:

java.lang.ClassNotFoundException - If a class with the specified name cannot be found.

java.lang.NullPointerException - If the supplied class name is null.

isSeverityEnabled

boolean isSeverityEnabled(int severity)

Returns true if the specified report severity level is enabled.

Parameters:

severity - The severity to check.

Returns:

True if the specified report severity level is enabled.

report

void report(int severity,
            java.lang.String[] categories,
            java.lang.String message,
            java.util.Dictionary properties)

Notifies this descriptor of a report made during the execution of the process.

Parameters:

severity - The severity of the report.

categories - The categories the report pertains to or null if no catagories are related.

message - The message associated with the report or null to not include a message.

properties - The properties of the report or null if no properties are specified.